Skip to content

DOC: Merge FAQ and gotcha #13768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Conversation

sinhrks
Copy link
Member

@sinhrks sinhrks commented Jul 24, 2016

@sinhrks sinhrks added the Docs label Jul 24, 2016
@sinhrks sinhrks added this to the 0.19.0 milestone Jul 24, 2016
@codecov-io
Copy link

codecov-io commented Jul 24, 2016

Current coverage is 85.25% (diff: 100%)

Merging #13768 into master will not change coverage

@@             master     #13768   diff @@
==========================================
  Files           140        140          
  Lines         50455      50455          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits          43014      43014          
  Misses         7441       7441          
  Partials          0          0          

Powered by Codecov. Last update 59f2557...8fcb152


::

s.ix['c':'e'+1]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's switch this example to use .loc instead

@shoyer
Copy link
Member

shoyer commented Jul 24, 2016

As @jorisvandenbossche mentioned in the issue discussing consolidating these pages, I would suggest removing the FAQ page and keeping the "Gotchas" page instead. In my opinion, most of these are a better fit there.

The only exception is "DataFrame memory usage" which should probably be moved somewhere else (it isn't a great fit in the FAQ, either). Maybe "Internals" or "Enhancing Performance"?

@jreback
Copy link
Contributor

jreback commented Jul 29, 2016

@jorisvandenbossche ?

@@ -1,20 +1,94 @@
.. currentmodule:: pandas
.. _gotchas:
.. _faq:
Copy link
Member

@jorisvandenbossche jorisvandenbossche Aug 15, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keep this as gotchas? as the file is still named like that?

Also, I would keep the filename intact (just to prevent possible changes in links that are not necessary)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but I see you changed the title below, then the link name change makes some sense

@jorisvandenbossche
Copy link
Member

As I said in the original issue, although I like the FAQ name, I have the feeling that the content is not really what you would expect from a pandas FAQ (I would expect to see general things like 'what is pandas?', 'how can I contribute?', 'how is pandas developed?', 'how does pandas depend on numpy?', ...), while this are more advanced "gotcha's".

@jreback
Copy link
Contributor

jreback commented Aug 26, 2016

@jorisvandenbossche @sinhrks status on this?

@jorisvandenbossche jorisvandenbossche modified the milestones: 0.20.0, 0.19.0 Aug 29, 2016
@jreback
Copy link
Contributor

jreback commented Nov 16, 2016

where are we on this?

@jreback
Copy link
Contributor

jreback commented Dec 21, 2016

@sinhrks can you rebase

@jreback
Copy link
Contributor

jreback commented Jan 21, 2017

status of this?

@jorisvandenbossche
Copy link
Member

@sinhrks rebased this + made some changes for the comments above -> #15222

jreback pushed a commit that referenced this pull request Jan 25, 2017
Rebase and clean-up of #13768
closes #9809

Author: Joris Van den Bossche <[email protected]>
Author: sinhrks <[email protected]>

Closes #15222 from jorisvandenbossche/pr/13768 and squashes the following commits:

7abb65b [Joris Van den Bossche] Make 'indexing may change dtype' more general
53a6970 [Joris Van den Bossche] Move HTML libraries gotchas to html io docs
7185dd4 [Joris Van den Bossche] Keep original gotchas label for references
c9e41cc [Joris Van den Bossche] Redo updates after ix deprecation
ab7fdf0 [Joris Van den Bossche] restore file name
f5e0af0 [sinhrks] DOC: Merge FAQ and gotcha
AnkurDedania pushed a commit to AnkurDedania/pandas that referenced this pull request Mar 21, 2017
Rebase and clean-up of pandas-dev#13768
closes pandas-dev#9809

Author: Joris Van den Bossche <[email protected]>
Author: sinhrks <[email protected]>

Closes pandas-dev#15222 from jorisvandenbossche/pr/13768 and squashes the following commits:

7abb65b [Joris Van den Bossche] Make 'indexing may change dtype' more general
53a6970 [Joris Van den Bossche] Move HTML libraries gotchas to html io docs
7185dd4 [Joris Van den Bossche] Keep original gotchas label for references
c9e41cc [Joris Van den Bossche] Redo updates after ix deprecation
ab7fdf0 [Joris Van den Bossche] restore file name
f5e0af0 [sinhrks] DOC: Merge FAQ and gotcha
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: merge FAQ / Caveats & Gotchas
5 participants